home *** CD-ROM | disk | FTP | other *** search
/ Amiga Developer CD 2.1 / Amiga Developer CD v2.1.iso / NDK / NDK_3.5 / Documentation / Autodocs / glyph_ic.doc < prev    next >
Encoding:
Text File  |  1999-10-29  |  3.1 KB  |  95 lines
  1. TABLE OF CONTENTS
  2.  
  3. glyph_ic/--datasheet--
  4. glyph_ic/GLYPH_GetClass
  5. glyph_ic/--datasheet--                              glyph_ic/--datasheet--
  6.  
  7.     NAME
  8.         glyph_ic -- create glyph BOOPSI objects
  9.  
  10.     SUPERCLASS
  11.         imageclass
  12.  
  13.     REQUIRES
  14.         drawlist.image
  15.  
  16.     DESCRIPTION
  17.         This image class can create scaled glyphs suitable for use
  18.         as gadget imagery or informational requestor imagery.
  19.         Either a penmap or drawlist scaled image is created internally,
  20.         and external user prefered glyph style sets may become possible
  21.         at a later date.
  22.  
  23.     METHODS
  24.         OM_NEW -- Create the glyph image. Passed to superclass, then OM_SET.
  25.  
  26.         OM_GET -- Get object attributes. Passed to superclass first.
  27.  
  28.         OM_SET -- Set object attributes.
  29.             Passed to superclass first.
  30.  
  31.         OM_UPDATE -- Set object notification attributes. Passed to
  32.             superclass first.
  33.  
  34.         IM_DRAW -- Renders the image. Overrides the superclass.
  35.  
  36.         IM_DRAWFRAME -- Renders the image scaled to fit in the frame.
  37.             Following IM_DRAW will be this size. Overrides the superclass.
  38.  
  39.         All other methods are passed to the superclass.
  40.  
  41.     ATTRIBUTES
  42.         GLYPH_Glyph (LONG)
  43.             Selects any one of the built-in scaled image glyphs.
  44.  
  45.             Current supported and defined in <gadgets/glyph.h>:
  46.  
  47.             GLYPH_NONE - No image.
  48.             GLYPH_DOWNARROW - Indicates downward movement control.
  49.             GLYPH_UPARROW - Indicates upward movement control.
  50.             GLYPH_LEFTARROW - Indicates left movement control.
  51.             GLYPH_RIGHTARROW - Indicates right movement control.
  52.             GLYPH_DROPDOWN - Denotes a drop-down menu.
  53.             GLYPH_POPUP - Denotes a pop-up menu.
  54.             GLYPH_CHECKMARK - Indicates a toggle.
  55.             GLYPH_POPFONT - Font selection.
  56.             GLYPH_POPFILE - File selection.
  57.             GLYPH_POPDRAWER - Drawer (directory) selection.
  58.             GLYPH_POPSCREENMODE - Screenmode selection.
  59.             GLYPH_POPTIME - Time selection.
  60.             GLYPH_RADIOBUTTON - Mutual exclusion item.
  61.             GLYPH_RETURNARROW - RETURN key controlled.
  62.  
  63.             Defaults to GLYPH_POPFILE.
  64.  
  65.             Applicability is (OM_NEW, OM_SET, OM_UPDATE)
  66. glyph_ic/GLYPH_GetClass                            glyph_ic/GLYPH_GetClass
  67.  
  68.     NAME
  69.         GLYPH_GetClass -- Gets the pointer to the glyph class.
  70.  
  71.     SYNOPSIS
  72.         glyph_class = GLYPH_GetClass();
  73.         D0
  74.  
  75.         Class * GLYPH_GetClass(VOID);
  76.  
  77.     FUNCTION
  78.         Obtains the pointer to the Glyph image class for use with
  79.         NewObject().  This function always returns a valid pointer so
  80.         you do not need to check it.  The reason is that if the library
  81.         opens fine, then the pointer returned is already setup.  (Of course
  82.         this implies that if opening the library fails, you shouldn't be
  83.         calling this.)
  84.  
  85.         Note that this function does not create the class, that is done
  86.         when the class library is opened.
  87.  
  88.     INPUTS
  89.         Nothing.
  90.  
  91.     RESULT
  92.         glyph_class - Pointer to the Glyph image class.
  93.  
  94.     SEE ALSO
  95.